home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Utilities / Database / VCArchive / makefilter / Filters.ReadMe (.txt) next >
LaTeX Document  |  1998-06-24  |  14KB  |  254 lines
  1.           
  2. [1mVideo & CD-Archive -- Export-Filters
  3.              
  4. [1mCopyright: Harald Zottmann 1997
  5. [1m1) What is it all about
  6. [1m=======================
  7. Since Version 3.30, the Video & CD-Archive is able to export
  8. data to various different formats. It therefore makes use
  9. of external Export-Filters, which can be written by the user.
  10. With this installation, the Video & CD-Archive comes already 
  11. featuring a large number of different filter types:
  12.   - ASCII format
  13.   - LaTeX format
  14.   - PostScript format
  15.   - PageStream format 
  16. [1m2) Write your own filter
  17. [1m========================
  18. All Export-Filter files must reside in the directory "Filters" which 
  19. is located beneath the program directory of the Video & CD-Archive.
  20. The Export-Filter names have various suffixes to distinguish between 
  21. them:
  22.  .MC   for Tapes
  23.  .PH   for Longplayers
  24.  .CD   for Compact Discs
  25.  .VI   for Video Tapes
  26. Export-Filter files are pure ASCII files which can be created and 
  27. modified by every normal text editor. Control sequences are used to 
  28. tell the program what to do. Supported control sequnces so far are:
  29. [32m@TXT
  30. [31m                write following ASCII text to export file
  31. [32m@BIN
  32. [31m                write binary data to output file
  33. [32m@REPxyz@abc
  34. [31m         replace sequence "xyz" with sequence "abc"
  35. [32m@%<format>s@xx@yy
  36. [31m   write dataset row and column to export file
  37. [1ma) Example for ASCII text data:
  38. [1m-------------------------------
  39. These rows define the beginning of a LaTeX document:
  40. [32m@TXT\documentstyle[german]{article}
  41. [32m@TXT\begin{document}
  42. [32m@TXT\footnotesize
  43. This row defines a horizontal line that is used in conjunction with
  44. the ASCII MC cover output:
  45. [32m@TXT|-------------------------------------------------------------------|
  46. [1mb) Example for binary data:
  47. [1m---------------------------
  48. This row defines binary data in hexadecimal notation (00-ff) to
  49. be written to the exported file:
  50. [32m@BIN 07 23 19 92 00 0d 02 00 00 00 e8 f8 00 01 49 7c 00 00 00 00
  51. [1mc) Example for replacements:
  52. [1m----------------------------
  53. These rows define e.g. the standard replacement list for LaTeX 
  54. Export-Filters:
  55. [32m@REP\@ \(\backslash\)
  56. [32m@REP~@ \~\
  57. [32m@REP^@ \^\
  58. [32m@REP$@ \$
  59. [32m@REP{@ \{
  60. [32m@REP}@ \}
  61. [32m@REP%@ \%
  62. [32m@REP&@ \&
  63. [32m@REP#@ \#
  64. [32m@REP_@ \_
  65. [32m@REP
  66. [32m@REP
  67. [32m@REP
  68. [32m@REP
  69. [32m@REP
  70. [32m@REP
  71. [32m@REP
  72. @\ss{}
  73. [1md) Example for dataset output:
  74. [1m------------------------------
  75. This row writes an `|` followed by row 14, starting with column 0
  76. of the current dataset with a minimum printing width of 33 characters.
  77. The format definition follows the syntax of the `C` programming language.
  78. Then comes again the character `|` and row 14, starting this time with
  79. column 34 of the current dataset. Note that in the MC and the CD case,
  80. column 0 means the left part of the cover and column 34 identifies the right
  81. part of the cover. The definition ends again with the character `|`:
  82. [32m@TXT|@%-33.33s@00@14@TXT|@%-33.33s@34@14@TXT|
  83. See the Export-Filter files that come with this package for examples
  84. and more details.
  85. [1m3) How to use the program `MakeFilter`
  86. [1m======================================
  87. This program is intended to support you to create Export-Filters for
  88. any third party program you like. I will explain the necessary steps
  89. using PageStream as an example.
  90. First of all you have to decide for what mode (MC, CD, Phono or Video)
  91. you want to create a new Export-Filter. Let`s say that you want to create
  92. a new MC cover design.
  93. Start PageStream and import the ASCII file `MakeFilter.MC` which contains
  94. necessary format definitions which is used by the program `MakeFilter` later on.
  95. The sequences of this file represent some kind of placeholder for the real 
  96. datasets which will be inserted during export with the Video & CD-Archive.
  97. You may change the position of these sequences by dragging them around or by
  98. copy and paste, but don`t modify the sequences themself at all, not even delete 
  99. them partly.
  100. You may now design the cover as you prefer it. You can use every feature 
  101. PageStream offers you, for example coloured lines, shaded text and so on. 
  102. You may even use cliparts in your cover design.
  103. If you`ve finished your work, save the cover as a normal PageStream document.
  104. In the directory `MakeFilter/PageStreamTemplates` there are some examples on 
  105. how these files may look like. You can also use these files and modify them 
  106. to your personal taste.
  107. Now invoke `MakeFilter` with the shell command:
  108.              
  109. [33mMakeFilter <PageStreamFile> <ExportFilter.MC>
  110. Note that PageStream uses a special character for the german `
  111. `. To implement
  112. the conversion between the `
  113. ` used by the Video & CD-Archive and the character
  114. used by PageStream, you have to add the line:
  115. [32m@REP
  116. at the top of the resulting Export-Filter file. This command directs the export
  117. function of the Video & CD-Archive to replace every `
  118. ` of the exported dataset 
  119. to a special character known by PageStream.
  120. Now copy the resulting file `ExportFilter.MC` to the `Filters` directory
  121. beneath the program directory and invoke the Video & CD-Archive`s export
  122. function from the main menu. Follow the steps described in the respective 
  123. section of the AmigaGuide file by pressing the `Help` key within the 
  124. Video & CD-Archive if you have problems here.
  125. If everything went fine, you now can load the just exported file directly to 
  126. PageStream and print it.
  127. Be aware that the procedure described above works only if the program you want
  128. to design Export-Filters for (e.g. FinalWriter, PageStream etc.) saves its files
  129. without changing the ASCII sequences of the format definitions file. That should
  130. normally be the case, but you never know.
  131. [1m4) How it works
  132. [1m===============
  133. MakeFilter is a pretty simple but nevertheless powerful tool. The way it works
  134. is converting the unknown binary data of some document file to @BIN sequences
  135. which are understood by the export function of the Video & CD-Archive.
  136. Well, that would not help too much if there weren`t those placeholders inserted
  137. in the document file, which are understood by MakeFilter and are replaced by
  138. [32m@%<format>s@xx@yy
  139. sequences which in turn are understood by the Video & CD-Archive. See chapter 2
  140. of this document for more information on those control sequences.
  141. The placeholders which have to be imported and arranged somehow in the template
  142. document, see chapter 4, have the following formats:
  143. [1ma) MC mode - MakeFilter.MC
  144. [1m--------------------------
  145. [32m@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  146. [32m@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  147. [32m@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  148. [32m@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  149. [32m@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  150. [32m@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  151. [32m@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  152. [32m@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  153. [32m@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  154. [32m@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  155. [32m@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  156. [32m@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  157. [32m@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  158. [32m@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  159. [32m@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  160. [32m@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  161. [32m@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  162. [32m@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  163. [32m@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  164. [32m@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  165. [1mb) CD mode - MakeFilter.CD
  166. [1m--------------------------
  167. [32m@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  168. [32m@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  169. [32m@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  170. [32m@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  171. [32m@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  172. [32m@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  173. [32m@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  174. [32m@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  175. [32m@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  176. [32m@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  177. [32m@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  178. [32m@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  179. [32m@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  180. [32m@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  181. [32m@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  182. [32m@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  183. [32m@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  184. [32m@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  185. [32m@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  186. [32m@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  187. [1mc) Phono mode - MakeFilter.PH
  188. [1m-----------------------------
  189. [32m@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  190. [32m@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  191. [32m@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  192. [32m@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  193. [32m@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  194. [32m@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  195. [32m@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  196. [32m@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  197. [32m@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  198. [32m@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  199. [32m@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  200. [32m@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  201. [32m@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  202. [32m@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  203. [32m@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  204. [32m@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  205. [32m@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  206. [32m@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  207. [32m@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  208. [32m@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  209. [1md) Video mode - MakeFilter.VI
  210. [1m-----------------------------
  211. [32m@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  212. [32m@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C1@ @D1@@@@@
  213. [32m@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C2@ @D2@@@@@
  214. [32m@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C3@ @D3@@@@@
  215. [32m@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C4@ @D4@@@@@
  216. [32m@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C5@ @D5@@@@@
  217. [32m@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C6@ @D6@@@@@
  218. [32m@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C7@ @D7@@@@@
  219. [32m@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C8@ @D8@@@@@
  220. [32m@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C9@ @D9@@@@@
  221. [32m@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @CA@ @DA@@@@@
  222. [32m@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @CB@ @DB@@@@@
  223. Every sequence start with the character `@`, followed by two characters
  224. which give the internal position of the dataset string. The first character
  225. may have values from A...D, giving the x position:
  226.  A --> 0    A-Side MC / Left-Side CD / Phono / Filmtitle-Field Video
  227.  B --> 34   B-Side MC / Right-Side CD
  228.  C --> 54   Time-Field Video
  229.  D --> 59   Counter-Field Video
  230. The second character defines the y position, giving the row of the dataset.
  231. This one may have values from 0...9 and from A...J which means 10 to 19 then.
  232. With this position information, a certain length information for the sequence
  233. in question is included. MakeFilter checks the length of the sequences and 
  234. compares that information with internal settings. If it encounters possible
  235. problems, it will give you detailed information on what might be incorrect.
  236. [1m5) What you might want to know now
  237. [1m==================================
  238. Note that new Export-Filters will be made available on my personal WWW site:
  239.               
  240. [33mhttp://home.t-online.de/home/harald.zottmann
  241. as soon as they are available. If you have written some new and 
  242. [1mreally good
  243. Export-Filters yourself, feel free to E-mail them to me in order to release 
  244. them on this site, or to get them included in a forthcoming release of the 
  245. program. As a reward for sending me Export-Filters which are 
  246. [1mworth
  247. [22m to be 
  248. released, you 
  249. [1mmay
  250. [22m earn a free KeyFile for the Video & CD-Archive. Note that 
  251. I will distribute free KeyFiles only via E-Mail and only if I receive an 
  252. electronic copy of the ORDERFORM with the requested personal data from you. 
  253. The ORDERFORM file is included in the Video & CD-Archive program package.
  254.